Get Available License Count for a Tenant

{ getTenantUnusedLicenseCount }

Returns the number of available licenses available for a given tenant.

Method

/API3/access/getTenantUnusedLicenseCount

  • API Section: /API3/access
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
    • Input Parameters

    Name

    tenantLicenseTypeData

    Object Type

    TenantLicenseTypeData

    Description

    The tenant license object with its license type.

    Output Response

    Successful Result Code

    200

    Response Type

    integer

    Description of Response Type

    successful operation

    Notes

    Use 'getLicenseCount' to get the total seat count. This method returns the unused seat count.

    Examples

    ClosedContent and Tag Operations (JavaScript):

    This example demonstrates how to find item's and the manipulation of content tags.

    The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

    // URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";


// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"abc123!"
},"",false);


//step 2: search for tenant by name
let tenant=callApi("access/getTenantByName","Company X",token);

let tenantId;

//step 3: if tenant is found, get its ID. Otherwise create the tenant
if(tenant.data != undefined){

    tenantId=tenant.data.id;
    log("found tenant with id "+ tenantId);
	
}else{

    log("tenant was not found ,creating one");
    let createTenantResult = callApi("access/createTenant",{
        "name": "Company X",
		"viewerSeats": 1,
		"proSeats": 1
    },token);
    tenantId = createTenantResult.data.modifiedList[0].id;
	
}


//step 4: delete the tenant we found in step 2
let deleteTenants=callApi("access/deleteTenants",{
	"tenantIds": [
		tenantId
	],
	"deleteUsers": true,
	"deleteServers": true
},token);

//step 5: get the default tenant
let defaultTenant = callApi("access/getDefaultTenant",{
  "auth": token
});

let defaultTenantId = defaultTenant.data;


//step 6: get available licenses by type for default tenant
let proSeatsNumber = callApi("access/getAvailableTenantLicenseCount",{
   "tenantId": defaultTenantId,
   "licenseType": 200,
},token);
log("The default tenant has "+ proSeatsNumber.data + " available pro seats licenses");

//step 7: get available users for tenant by license type
let proSeatsUsersData = callApi("access/getAllUsersDataByTenantAndLicenceType",{
  "tenantId": defaultTenantId,
  "clientLicenseType": 200,
},token);


// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/access/getTenantUnusedLicenseCount" \
 -d '{
  "licenseType" : "Scientist",
  "tenantId" : "tenantId"
}'

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AccessServiceApi;

import java.util.*;

public class AccessServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AccessServiceApi apiInstance = new AccessServiceApi();
        // Initialize the tenantLicenseTypeData parameter object for the call
        TenantLicenseTypeData tenantLicenseTypeData = ; // TenantLicenseTypeData | 

        try {
            'Integer' result = apiInstance.getTenantUnusedLicenseCount(tenantLicenseTypeData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessServiceApi#getTenantUnusedLicenseCount");
            e.printStackTrace();
        }
    }
}

    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;

// Configure API key authorization: paToken
const paToken = defaultClient.authentications['paToken'];
paToken.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.apiKeyPrefix['paToken'] = "Token";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
const tenantLicenseTypeData = ; // {TenantLicenseTypeData} 

const callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTenantUnusedLicenseCount(tenantLicenseTypeData, callback);

    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getTenantUnusedLicenseCountExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new AccessServiceApi();
        // Initialize the tenantLicenseTypeData parameter object for the call
        var tenantLicenseTypeData = new TenantLicenseTypeData(); // TenantLicenseTypeData | 

        try {
            // Returns the number of available licenses available for a given tenant.
            'Integer' result = apiInstance.getTenantUnusedLicenseCount(tenantLicenseTypeData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AccessServiceApi.getTenantUnusedLicenseCount: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from pprint import pprint


# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# api_config.api_key_prefix['paToken'] = 'Bearer'

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = com.pyramidanalytics.AccessServiceApi(api_client)
    # Initialize the tenantLicenseTypeData parameter object for the call
    tenantLicenseTypeData =  # TenantLicenseTypeData | 

    try:
        # Returns the number of available licenses available for a given tenant.
        api_response = api_instance.get_tenant_unused_license_count(tenantLicenseTypeData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessServiceApi->getTenantUnusedLicenseCount: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
$tenantLicenseTypeData = ; // TenantLicenseTypeData | 

try {
    $result = $api_instance->getTenantUnusedLicenseCount($tenantLicenseTypeData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessServiceApi->getTenantUnusedLicenseCount: ', $e->getMessage(), PHP_EOL;
}
?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.